<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>Search xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../../../../../../../../apidocs/org/sakaiproject/genericdao/api/search/Search.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em>/**<em>*</em></em>
<a name="2" href="#2">2</a>   <em> * $Id: Search.html 11 2009-01-29 14:58:33Z azeckoski $</em>
<a name="3" href="#3">3</a>   <em> * $URL: http://genericdao.googlecode.com/svn/maven/site/xref/org/sakaiproject/genericdao/api/search/Search.html $</em>
<a name="4" href="#4">4</a>   <em> * Search.java - gendao - Apr 8, 2008 11:50:18 AM - azeckoski</em>
<a name="5" href="#5">5</a>   <em> **************************************************************************</em>
<a name="6" href="#6">6</a>   <em> * Copyright (c) 2008 Aaron Zeckoski</em>
<a name="7" href="#7">7</a>   <em> * Licensed under the Apache License, Version 2</em>
<a name="8" href="#8">8</a>   <em> * </em>
<a name="9" href="#9">9</a>   <em> * A copy of the Apache License, Version 2 has been included in this </em>
<a name="10" href="#10">10</a>  <em> * distribution and is available at: <a href="http://www.apache.org/licenses/LICENSE-2.0.txt" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0.txt</a></em>
<a name="11" href="#11">11</a>  <em> *</em>
<a name="12" href="#12">12</a>  <em> * Aaron Zeckoski (azeckoski@gmail.com) (aaronz@vt.edu) (aaron@caret.cam.ac.uk)</em>
<a name="13" href="#13">13</a>  <em> */</em>
<a name="14" href="#14">14</a>  
<a name="15" href="#15">15</a>  <strong>package</strong> org.sakaiproject.genericdao.api.search;
<a name="16" href="#16">16</a>  
<a name="17" href="#17">17</a>  <strong>import</strong> java.lang.reflect.Array;
<a name="18" href="#18">18</a>  <strong>import</strong> java.util.ArrayList;
<a name="19" href="#19">19</a>  <strong>import</strong> java.util.Arrays;
<a name="20" href="#20">20</a>  <strong>import</strong> java.util.List;
<a name="21" href="#21">21</a>  
<a name="22" href="#22">22</a>  <em>/**<em>*</em></em>
<a name="23" href="#23">23</a>  <em> * This is a simple class which allows the passing of a set of search parameters in a nice way&lt;br/></em>
<a name="24" href="#24">24</a>  <em> * Example usage:&lt;br/></em>
<a name="25" href="#25">25</a>  <em> * &lt;code>Search s1 = new Search("title", curTitle); // search where title equals value of curTitle&lt;/code>&lt;br/></em>
<a name="26" href="#26">26</a>  <em> * &lt;code>Search s2 = new Search("title", curTitle, Restriction.NOT_EQUALS); // search where title not equals value of curTitle&lt;/code>&lt;br/></em>
<a name="27" href="#27">27</a>  <em> * &lt;code>Search s2 = new Search(&lt;br/></em>
<a name="28" href="#28">28</a>  <em> *    new Restriction("title", curTitle),&lt;br/> </em>
<a name="29" href="#29">29</a>  <em> *    new Order("title")&lt;br/></em>
<a name="30" href="#30">30</a>  <em> * ); // search where title equals value of curTitle and order is by title ascending&lt;/code>&lt;br/></em>
<a name="31" href="#31">31</a>  <em> * &lt;br/></em>
<a name="32" href="#32">32</a>  <em> * Most searches can be modeled this way fairly easily. There are many constructors to make</em>
<a name="33" href="#33">33</a>  <em> * it easy for a developer to write the search they want inside the search constructor.&lt;br/></em>
<a name="34" href="#34">34</a>  <em> * There are also some methods to allow easy construction of searches in multiple steps:</em>
<a name="35" href="#35">35</a>  <em> * {@link #addOrder(Order)} and {@link #addRestriction(Restriction)} allow restrictions and orders</em>
<a name="36" href="#36">36</a>  <em> * to be added after the search was constructed, they will correctly handle duplicate values as well.&lt;br/></em>
<a name="37" href="#37">37</a>  <em> * Currently searches are completely conjunctive (all ANDs) or disjunction (all ORs)&lt;br/></em>
<a name="38" href="#38">38</a>  <em> * &lt;br/></em>
<a name="39" href="#39">39</a>  <em> * There is also an option to pass a search string as well which can contain</em>
<a name="40" href="#40">40</a>  <em> * formatted text to be interpreted by whatever is using the search object&lt;br/></em>
<a name="41" href="#41">41</a>  <em> * &lt;br/></em>
<a name="42" href="#42">42</a>  <em> * Finally, there are a few methods to make it easier to unpack and work with the search object:</em>
<a name="43" href="#43">43</a>  <em> * {@link #isEmpty()} and {@link #getRestrictionByProperty(String)} and {@link #getRestrictionsProperties()}</em>
<a name="44" href="#44">44</a>  <em> * make it easier to get the restriction information out of the search object</em>
<a name="45" href="#45">45</a>  <em> * </em>
<a name="46" href="#46">46</a>  <em> * @author Aaron Zeckoski (aaronz@caret.cam.ac.uk)</em>
<a name="47" href="#47">47</a>  <em> */</em>
<a name="48" href="#48">48</a>  <strong>public</strong> <strong>class</strong> <a href="../../../../../org/sakaiproject/genericdao/api/search/Search.html">Search</a> {
<a name="49" href="#49">49</a>  
<a name="50" href="#50">50</a>     <em>/**<em>*</em></em>
<a name="51" href="#51">51</a>  <em>    * the index of the first persisted result object to be retrieved (numbered from 0)</em>
<a name="52" href="#52">52</a>  <em>    */</em>
<a name="53" href="#53">53</a>     <strong>private</strong> <strong>long</strong> start = 0;
<a name="54" href="#54">54</a>     <strong>public</strong> <strong>void</strong> setStart(<strong>long</strong> start) {
<a name="55" href="#55">55</a>        <strong>this</strong>.start = start &lt; 0 ? 0 : start;
<a name="56" href="#56">56</a>     }
<a name="57" href="#57">57</a>     <strong>public</strong> <strong>long</strong> getStart() {
<a name="58" href="#58">58</a>        <strong>return</strong> start;
<a name="59" href="#59">59</a>     }
<a name="60" href="#60">60</a>  
<a name="61" href="#61">61</a>     <em>/**<em>*</em></em>
<a name="62" href="#62">62</a>  <em>    * the maximum number of persisted result objects to retrieve (or 0 for no limit)</em>
<a name="63" href="#63">63</a>  <em>    */</em>
<a name="64" href="#64">64</a>     <strong>private</strong> <strong>long</strong> limit = 0;
<a name="65" href="#65">65</a>     <strong>public</strong> <strong>void</strong> setLimit(<strong>long</strong> limit) {
<a name="66" href="#66">66</a>        <strong>this</strong>.limit = limit &lt; 0 ? 0 : limit;
<a name="67" href="#67">67</a>     }
<a name="68" href="#68">68</a>     <strong>public</strong> <strong>long</strong> getLimit() {
<a name="69" href="#69">69</a>        <strong>return</strong> limit;
<a name="70" href="#70">70</a>     }
<a name="71" href="#71">71</a>  
<a name="72" href="#72">72</a>     <em>/**<em>*</em></em>
<a name="73" href="#73">73</a>  <em>    * if true then all restrictions are run using AND, if false then all restrictions are run using OR &lt;br/></em>
<a name="74" href="#74">74</a>  <em>    * Currently searches are completely conjunctive (all ANDs) or disjunction (all ORs)</em>
<a name="75" href="#75">75</a>  <em>    */</em>
<a name="76" href="#76">76</a>     <strong>public</strong> <strong>boolean</strong> conjunction = <strong>true</strong>;
<a name="77" href="#77">77</a>     <em>/**<em>*</em></em>
<a name="78" href="#78">78</a>  <em>    * if true then all restrictions are run using AND, if false then all restrictions are run using OR</em>
<a name="79" href="#79">79</a>  <em>    * Currently searches are completely conjunctive (all ANDs) or disjunction (all ORs)</em>
<a name="80" href="#80">80</a>  <em>    */</em>
<a name="81" href="#81">81</a>     <strong>public</strong> <strong>boolean</strong> isConjunction() {
<a name="82" href="#82">82</a>        <strong>return</strong> conjunction;
<a name="83" href="#83">83</a>     }
<a name="84" href="#84">84</a>     <strong>public</strong> <strong>void</strong> setConjunction(<strong>boolean</strong> conjunction) {
<a name="85" href="#85">85</a>        <strong>this</strong>.conjunction = conjunction;
<a name="86" href="#86">86</a>     }
<a name="87" href="#87">87</a>  
<a name="88" href="#88">88</a>     <em>/**<em>*</em></em>
<a name="89" href="#89">89</a>  <em>    * Restrictions define limitations on the results of a search, e.g. propertyA > 100 or property B = 'jump'&lt;br/> You</em>
<a name="90" href="#90">90</a>  <em>    * can add as many restrictions as you like and they will be applied in the array order</em>
<a name="91" href="#91">91</a>  <em>    */</em>
<a name="92" href="#92">92</a>     <strong>private</strong> <a href="../../../../../org/sakaiproject/genericdao/api/search/Restriction.html">Restriction</a>[] restrictions = <strong>new</strong> <a href="../../../../../org/sakaiproject/genericdao/api/search/Restriction.html">Restriction</a>[] {};
<a name="93" href="#93">93</a>     <em>/**<em>*</em></em>
<a name="94" href="#94">94</a>  <em>    * Restrictions define limitations on the results of a search, e.g. propertyA > 100 or property B = 'jump'&lt;br/> You</em>
<a name="95" href="#95">95</a>  <em>    * can add as many restrictions as you like and they will be applied in the array order</em>
<a name="96" href="#96">96</a>  <em>    */</em>
<a name="97" href="#97">97</a>     <strong>public</strong> <a href="../../../../../org/sakaiproject/genericdao/api/search/Restriction.html">Restriction</a>[] getRestrictions() {
<a name="98" href="#98">98</a>        <strong>return</strong> restrictions;
<a name="99" href="#99">99</a>     }
<a name="100" href="#100">100</a>    <strong>public</strong> <strong>void</strong> setRestrictions(<a href="../../../../../org/sakaiproject/genericdao/api/search/Restriction.html">Restriction</a>[] restrictions) {
<a name="101" href="#101">101</a>       <strong>this</strong>.restrictions = restrictions;
<a name="102" href="#102">102</a>    }
<a name="103" href="#103">103</a> 
<a name="104" href="#104">104</a>    <em>/**<em>*</em></em>
<a name="105" href="#105">105</a> <em>    * Orders define the order of the returned results of a search, You can add as many orders as you like and they will</em>
<a name="106" href="#106">106</a> <em>    * be applied in the array order</em>
<a name="107" href="#107">107</a> <em>    */</em>
<a name="108" href="#108">108</a>    <strong>private</strong> <a href="../../../../../org/sakaiproject/genericdao/api/search/Order.html">Order</a>[] orders = <strong>new</strong> <a href="../../../../../org/sakaiproject/genericdao/api/search/Order.html">Order</a>[] {};
<a name="109" href="#109">109</a>    <em>/**<em>*</em></em>
<a name="110" href="#110">110</a> <em>    * Orders define the order of the returned results of a search, You can add as many orders as you like and they will</em>
<a name="111" href="#111">111</a> <em>    * be applied in the array order</em>
<a name="112" href="#112">112</a> <em>    */</em>
<a name="113" href="#113">113</a>    <strong>public</strong> <a href="../../../../../org/sakaiproject/genericdao/api/search/Order.html">Order</a>[] getOrders() {
<a name="114" href="#114">114</a>       <strong>return</strong> orders;
<a name="115" href="#115">115</a>    }
<a name="116" href="#116">116</a>    <strong>public</strong> <strong>void</strong> setOrders(<a href="../../../../../org/sakaiproject/genericdao/api/search/Order.html">Order</a>[] orders) {
<a name="117" href="#117">117</a>       <strong>this</strong>.orders = orders;
<a name="118" href="#118">118</a>    }
<a name="119" href="#119">119</a> 
<a name="120" href="#120">120</a>    <em>/**<em>*</em></em>
<a name="121" href="#121">121</a> <em>    * Defines a search query string which will be interpreted into search params,</em>
<a name="122" href="#122">122</a> <em>    * If not null this indicates that this is a string based "search"&lt;br/></em>
<a name="123" href="#123">123</a> <em>    * The search string is just text - there is no required structure nor any fieldModifiers. It is a freeform string.&lt;br/></em>
<a name="124" href="#124">124</a> <em>    * Effectively the semantics are that it can be implemented in a relational database using </em>
<a name="125" href="#125">125</a> <em>    * like clauses for the relevant text fields - or perhaps just submitted to lucene and see which entities match.&lt;br/></em>
<a name="126" href="#126">126</a> <em>    * If this is being sent to lucene - things like order, and restrictions might actually be added to the </em>
<a name="127" href="#127">127</a> <em>    * lucene query in addition to the simple search string.</em>
<a name="128" href="#128">128</a> <em>    */</em>
<a name="129" href="#129">129</a>    <strong>private</strong> String queryString = <strong>null</strong>;
<a name="130" href="#130">130</a>    <em>/**<em>*</em></em>
<a name="131" href="#131">131</a> <em>    * Defines a search query string which will be interpreted into search params,</em>
<a name="132" href="#132">132</a> <em>    * If not null this indicates that this is a string based "search"&lt;br/></em>
<a name="133" href="#133">133</a> <em>    * The search string is just text - there is no required structure nor any fieldModifiers. It is a freeform string.&lt;br/></em>
<a name="134" href="#134">134</a> <em>    * Effectively the semantics are that it can be implemented in a relational database using </em>
<a name="135" href="#135">135</a> <em>    * like clauses for the relevant text fields - or perhaps just submitted to lucene and see which entities match.&lt;br/></em>
<a name="136" href="#136">136</a> <em>    * If this is being sent to lucene - things like order, and restrictions might actually be added to the </em>
<a name="137" href="#137">137</a> <em>    * lucene query in addition to the simple search string.</em>
<a name="138" href="#138">138</a> <em>    */</em>
<a name="139" href="#139">139</a>    <strong>public</strong> String getQueryString() {
<a name="140" href="#140">140</a>       <strong>return</strong> queryString;
<a name="141" href="#141">141</a>    }
<a name="142" href="#142">142</a>    <strong>public</strong> <strong>void</strong> setQueryString(String queryString) {
<a name="143" href="#143">143</a>       <strong>this</strong>.queryString = queryString;
<a name="144" href="#144">144</a>    }
<a name="145" href="#145">145</a> 
<a name="146" href="#146">146</a> 
<a name="147" href="#147">147</a>    <em class="comment">// CONSTRUCTORS</em>
<a name="148" href="#148">148</a> 
<a name="149" href="#149">149</a>    <em>/**<em>*</em></em>
<a name="150" href="#150">150</a> <em>    * Empty constructor, </em>
<a name="151" href="#151">151</a> <em>    * if nothing is changed then this indicates that the search should return</em>
<a name="152" href="#152">152</a> <em>    * all items in default order</em>
<a name="153" href="#153">153</a> <em>    */</em>
<a name="154" href="#154">154</a>    <strong>public</strong> <a href="../../../../../org/sakaiproject/genericdao/api/search/Search.html">Search</a>() {}
<a name="155" href="#155">155</a> 
<a name="156" href="#156">156</a>    <em>/**<em>*</em></em>
<a name="157" href="#157">157</a> <em>    * Copy constructor&lt;br/></em>
<a name="158" href="#158">158</a> <em>    * Use this create a duplicate of a search object</em>
<a name="159" href="#159">159</a> <em>    */</em>
<a name="160" href="#160">160</a>    <strong>public</strong> <a href="../../../../../org/sakaiproject/genericdao/api/search/Search.html">Search</a>(<a href="../../../../../org/sakaiproject/genericdao/api/search/Search.html">Search</a> search) {
<a name="161" href="#161">161</a>       copy(search, <strong>this</strong>);
<a name="162" href="#162">162</a>    }
<a name="163" href="#163">163</a> 
<a name="164" href="#164">164</a>    <em>/**<em>*</em></em>
<a name="165" href="#165">165</a> <em>    * Do a search using a query string&lt;br/></em>
<a name="166" href="#166">166</a> <em>    * @param queryString a search query string,</em>
<a name="167" href="#167">167</a> <em>    * can be combined with other parts of the search object</em>
<a name="168" href="#168">168</a> <em>    * @see #queryString</em>
<a name="169" href="#169">169</a> <em>    */</em>
<a name="170" href="#170">170</a>    <strong>public</strong> <a href="../../../../../org/sakaiproject/genericdao/api/search/Search.html">Search</a>(String queryString) {
<a name="171" href="#171">171</a>       <strong>this</strong>.queryString = queryString;
<a name="172" href="#172">172</a>    }
<a name="173" href="#173">173</a> 
<a name="174" href="#174">174</a>    <em>/**<em>*</em></em>
<a name="175" href="#175">175</a> <em>    * Do a simple search of a single property which must equal a single value</em>
<a name="176" href="#176">176</a> <em>    * </em>
<a name="177" href="#177">177</a> <em>    * @param property</em>
<a name="178" href="#178">178</a> <em>    *           the name of the field (property) in the persisted object</em>
<a name="179" href="#179">179</a> <em>    * @param value</em>
<a name="180" href="#180">180</a> <em>    *           the value of the property (can be an array of items)</em>
<a name="181" href="#181">181</a> <em>    */</em>
<a name="182" href="#182">182</a>    <strong>public</strong> <a href="../../../../../org/sakaiproject/genericdao/api/search/Search.html">Search</a>(String property, Object value) {
<a name="183" href="#183">183</a>       restrictions = <strong>new</strong> <a href="../../../../../org/sakaiproject/genericdao/api/search/Restriction.html">Restriction</a>[] { <strong>new</strong> Restriction(property, value) };
<a name="184" href="#184">184</a>    }
<a name="185" href="#185">185</a> 
<a name="186" href="#186">186</a>    <em>/**<em>*</em></em>
<a name="187" href="#187">187</a> <em>    * Do a simple search of a single property with a single type of comparison</em>
<a name="188" href="#188">188</a> <em>    * </em>
<a name="189" href="#189">189</a> <em>    * @param property</em>
<a name="190" href="#190">190</a> <em>    *           the name of the field (property) in the persisted object</em>
<a name="191" href="#191">191</a> <em>    * @param value</em>
<a name="192" href="#192">192</a> <em>    *           the value of the property (can be an array of items)</em>
<a name="193" href="#193">193</a> <em>    * @param comparison the comparison to make between the property and the value,</em>
<a name="194" href="#194">194</a> <em>    * use the defined constants from {@link Restriction}: e.g. EQUALS, LIKE, etc...</em>
<a name="195" href="#195">195</a> <em>    */</em>
<a name="196" href="#196">196</a>    <strong>public</strong> <a href="../../../../../org/sakaiproject/genericdao/api/search/Search.html">Search</a>(String property, Object value, <strong>int</strong> comparison) {
<a name="197" href="#197">197</a>       restrictions = <strong>new</strong> <a href="../../../../../org/sakaiproject/genericdao/api/search/Restriction.html">Restriction</a>[] { <strong>new</strong> Restriction(property, value, comparison) };
<a name="198" href="#198">198</a>    }
<a name="199" href="#199">199</a> 
<a name="200" href="#200">200</a>    <em>/**<em>*</em></em>
<a name="201" href="#201">201</a> <em>    * Do a search of multiple properties which must equal corresponding values,</em>
<a name="202" href="#202">202</a> <em>    * all arrays should be the same length</em>
<a name="203" href="#203">203</a> <em>    * @param properties the names of the properties of the object </em>
<a name="204" href="#204">204</a> <em>    * @param values the values of the properties (can be an array of items)</em>
<a name="205" href="#205">205</a> <em>    */</em>
<a name="206" href="#206">206</a>    <strong>public</strong> <a href="../../../../../org/sakaiproject/genericdao/api/search/Search.html">Search</a>(String[] properties, Object[] values) {
<a name="207" href="#207">207</a>       restrictions = <strong>new</strong> <a href="../../../../../org/sakaiproject/genericdao/api/search/Restriction.html">Restriction</a>[properties.length];
<a name="208" href="#208">208</a>       <strong>for</strong> (<strong>int</strong> i = 0; i &lt; properties.length; i++) {
<a name="209" href="#209">209</a>          restrictions[i] = <strong>new</strong> <a href="../../../../../org/sakaiproject/genericdao/api/search/Restriction.html">Restriction</a>(properties[i], values[i]);
<a name="210" href="#210">210</a>       }
<a name="211" href="#211">211</a>    }
<a name="212" href="#212">212</a> 
<a name="213" href="#213">213</a>    <em>/**<em>*</em></em>
<a name="214" href="#214">214</a> <em>    * Do a search of multiple properties which must equal corresponding values,</em>
<a name="215" href="#215">215</a> <em>    * control whether to do an AND or an OR between restrictions,</em>
<a name="216" href="#216">216</a> <em>    * all arrays should be the same length</em>
<a name="217" href="#217">217</a> <em>    * @param properties the names of the properties of the object </em>
<a name="218" href="#218">218</a> <em>    * @param values the values of the properties (can be an array of items)</em>
<a name="219" href="#219">219</a> <em>    * @param conjunction if true then all restrictions are run using AND, </em>
<a name="220" href="#220">220</a> <em>    * if false then all restrictions are run using OR</em>
<a name="221" href="#221">221</a> <em>    */</em>
<a name="222" href="#222">222</a>    <strong>public</strong> <a href="../../../../../org/sakaiproject/genericdao/api/search/Search.html">Search</a>(String[] properties, Object[] values, <strong>boolean</strong> conjunction) {
<a name="223" href="#223">223</a>       restrictions = <strong>new</strong> <a href="../../../../../org/sakaiproject/genericdao/api/search/Restriction.html">Restriction</a>[properties.length];
<a name="224" href="#224">224</a>       <strong>for</strong> (<strong>int</strong> i = 0; i &lt; properties.length; i++) {
<a name="225" href="#225">225</a>          restrictions[i] = <strong>new</strong> <a href="../../../../../org/sakaiproject/genericdao/api/search/Restriction.html">Restriction</a>(properties[i], values[i]);
<a name="226" href="#226">226</a>       }
<a name="227" href="#227">227</a>       <strong>this</strong>.conjunction = conjunction;
<a name="228" href="#228">228</a>    }
<a name="229" href="#229">229</a> 
<a name="230" href="#230">230</a>    <em>/**<em>*</em></em>
<a name="231" href="#231">231</a> <em>    * Do a search of multiple properties which are compared with corresponding values,</em>
<a name="232" href="#232">232</a> <em>    * all arrays should be the same length</em>
<a name="233" href="#233">233</a> <em>    * @param properties the names of the properties of the object </em>
<a name="234" href="#234">234</a> <em>    * @param values the values of the properties (can be an array of items)</em>
<a name="235" href="#235">235</a> <em>    * @param comparisons the comparison to make between the property and the value,</em>
<a name="236" href="#236">236</a> <em>    * use the defined constants from {@link Restriction}: e.g. EQUALS, LIKE, etc...</em>
<a name="237" href="#237">237</a> <em>    */</em>
<a name="238" href="#238">238</a>    <strong>public</strong> <a href="../../../../../org/sakaiproject/genericdao/api/search/Search.html">Search</a>(String[] properties, Object[] values, <strong>int</strong>[] comparisons) {
<a name="239" href="#239">239</a>       restrictions = <strong>new</strong> <a href="../../../../../org/sakaiproject/genericdao/api/search/Restriction.html">Restriction</a>[properties.length];
<a name="240" href="#240">240</a>       <strong>for</strong> (<strong>int</strong> i = 0; i &lt; properties.length; i++) {
<a name="241" href="#241">241</a>          restrictions[i] = <strong>new</strong> <a href="../../../../../org/sakaiproject/genericdao/api/search/Restriction.html">Restriction</a>(properties[i], values[i], comparisons[i]);
<a name="242" href="#242">242</a>       }
<a name="243" href="#243">243</a>    }
<a name="244" href="#244">244</a> 
<a name="245" href="#245">245</a>    <em>/**<em>*</em></em>
<a name="246" href="#246">246</a> <em>    * Do a search of multiple properties which are compared with corresponding values,</em>
<a name="247" href="#247">247</a> <em>    * all arrays should be the same length</em>
<a name="248" href="#248">248</a> <em>    * @param properties the names of the properties of the object </em>
<a name="249" href="#249">249</a> <em>    * @param values the values of the properties (can be an array of items)</em>
<a name="250" href="#250">250</a> <em>    * @param comparisons the comparison to make between the property and the value,</em>
<a name="251" href="#251">251</a> <em>    * use the defined constants from {@link Restriction}: e.g. EQUALS, LIKE, etc...</em>
<a name="252" href="#252">252</a> <em>    * @param conjunction if true then all restrictions are run using AND, </em>
<a name="253" href="#253">253</a> <em>    * if false then all restrictions are run using OR</em>
<a name="254" href="#254">254</a> <em>    */</em>
<a name="255" href="#255">255</a>    <strong>public</strong> <a href="../../../../../org/sakaiproject/genericdao/api/search/Search.html">Search</a>(String[] properties, Object[] values, <strong>int</strong>[] comparisons, <strong>boolean</strong> conjunction) {
<a name="256" href="#256">256</a>       restrictions = <strong>new</strong> <a href="../../../../../org/sakaiproject/genericdao/api/search/Restriction.html">Restriction</a>[properties.length];
<a name="257" href="#257">257</a>       <strong>for</strong> (<strong>int</strong> i = 0; i &lt; properties.length; i++) {
<a name="258" href="#258">258</a>          restrictions[i] = <strong>new</strong> <a href="../../../../../org/sakaiproject/genericdao/api/search/Restriction.html">Restriction</a>(properties[i], values[i], comparisons[i]);
<a name="259" href="#259">259</a>       }
<a name="260" href="#260">260</a>       <strong>this</strong>.conjunction = conjunction;
<a name="261" href="#261">261</a>    }
<a name="262" href="#262">262</a> 
<a name="263" href="#263">263</a>    <em>/**<em>*</em></em>
<a name="264" href="#264">264</a> <em>    * Do a search of multiple properties which are compared with corresponding values,</em>
<a name="265" href="#265">265</a> <em>    * sort the returned results in ascending order defined by specific sortProperties,</em>
<a name="266" href="#266">266</a> <em>    * all arrays should be the same length</em>
<a name="267" href="#267">267</a> <em>    * @param properties the names of the properties of the object </em>
<a name="268" href="#268">268</a> <em>    * @param values the values of the properties (can be an array of items)</em>
<a name="269" href="#269">269</a> <em>    * @param comparisons the comparison to make between the property and the value,</em>
<a name="270" href="#270">270</a> <em>    * use the defined constants from {@link Restriction}: e.g. EQUALS, LIKE, etc...</em>
<a name="271" href="#271">271</a> <em>    * @param orders orders to sort the returned results by</em>
<a name="272" href="#272">272</a> <em>    */</em>
<a name="273" href="#273">273</a>    <strong>public</strong> <a href="../../../../../org/sakaiproject/genericdao/api/search/Search.html">Search</a>(String[] properties, Object[] values, <strong>int</strong>[] comparisons, <a href="../../../../../org/sakaiproject/genericdao/api/search/Order.html">Order</a>[] orders) {
<a name="274" href="#274">274</a>       restrictions = <strong>new</strong> <a href="../../../../../org/sakaiproject/genericdao/api/search/Restriction.html">Restriction</a>[properties.length];
<a name="275" href="#275">275</a>       <strong>for</strong> (<strong>int</strong> i = 0; i &lt; properties.length; i++) {
<a name="276" href="#276">276</a>          restrictions[i] = <strong>new</strong> <a href="../../../../../org/sakaiproject/genericdao/api/search/Restriction.html">Restriction</a>(properties[i], values[i], comparisons[i]);
<a name="277" href="#277">277</a>       }
<a name="278" href="#278">278</a>       <strong>this</strong>.orders = orders;
<a name="279" href="#279">279</a>    }
<a name="280" href="#280">280</a> 
<a name="281" href="#281">281</a>    <em>/**<em>*</em></em>
<a name="282" href="#282">282</a> <em>    * Do a search of multiple properties which are compared with corresponding values,</em>
<a name="283" href="#283">283</a> <em>    * sort the returned results in ascending order defined by specific sortProperties,</em>
<a name="284" href="#284">284</a> <em>    * all arrays should be the same length</em>
<a name="285" href="#285">285</a> <em>    * @param properties the names of the properties of the object </em>
<a name="286" href="#286">286</a> <em>    * @param values the values of the properties (can be an array of items)</em>
<a name="287" href="#287">287</a> <em>    * @param comparisons the comparison to make between the property and the value,</em>
<a name="288" href="#288">288</a> <em>    * use the defined constants from {@link Restriction}: e.g. EQUALS, LIKE, etc...</em>
<a name="289" href="#289">289</a> <em>    * @param orders orders to sort the returned results by</em>
<a name="290" href="#290">290</a> <em>    * @param firstResult the index of the first persisted result object to be retrieved (numbered from 0)</em>
<a name="291" href="#291">291</a> <em>    * @param maxResults the maximum number of persisted result objects to retrieve (or &lt;=0 for no limit)</em>
<a name="292" href="#292">292</a> <em>    */</em>
<a name="293" href="#293">293</a>    <strong>public</strong> <a href="../../../../../org/sakaiproject/genericdao/api/search/Search.html">Search</a>(String[] properties, Object[] values, <strong>int</strong>[] comparisons, 
<a name="294" href="#294">294</a>          <a href="../../../../../org/sakaiproject/genericdao/api/search/Order.html">Order</a>[] orders, <strong>long</strong> firstResult, <strong>long</strong> maxResults) {
<a name="295" href="#295">295</a>       restrictions = <strong>new</strong> <a href="../../../../../org/sakaiproject/genericdao/api/search/Restriction.html">Restriction</a>[properties.length];
<a name="296" href="#296">296</a>       <strong>for</strong> (<strong>int</strong> i = 0; i &lt; properties.length; i++) {
<a name="297" href="#297">297</a>          restrictions[i] = <strong>new</strong> <a href="../../../../../org/sakaiproject/genericdao/api/search/Restriction.html">Restriction</a>(properties[i], values[i], comparisons[i]);
<a name="298" href="#298">298</a>       }
<a name="299" href="#299">299</a>       <strong>this</strong>.orders = orders;
<a name="300" href="#300">300</a>       <strong>this</strong>.start = firstResult;
<a name="301" href="#301">301</a>       <strong>this</strong>.limit = maxResults;
<a name="302" href="#302">302</a>    }
<a name="303" href="#303">303</a> 
<a name="304" href="#304">304</a>    <em>/**<em>*</em></em>
<a name="305" href="#305">305</a> <em>    * Defines a search which defines only a single restriction,</em>
<a name="306" href="#306">306</a> <em>    * defaults to AND restriction comparison and returning all results</em>
<a name="307" href="#307">307</a> <em>    * @param restriction define the limitations on the results of a search, </em>
<a name="308" href="#308">308</a> <em>    * e.g. propertyA > 100 or property B = 'jump'&lt;br/> </em>
<a name="309" href="#309">309</a> <em>    * You can add as many restrictions as you like and they will be applied in the array order</em>
<a name="310" href="#310">310</a> <em>    */</em>
<a name="311" href="#311">311</a>    <strong>public</strong> <a href="../../../../../org/sakaiproject/genericdao/api/search/Search.html">Search</a>(<a href="../../../../../org/sakaiproject/genericdao/api/search/Restriction.html">Restriction</a> restriction) {
<a name="312" href="#312">312</a>       <strong>this</strong>.restrictions = <strong>new</strong> <a href="../../../../../org/sakaiproject/genericdao/api/search/Restriction.html">Restriction</a>[] { restriction };
<a name="313" href="#313">313</a>    }
<a name="314" href="#314">314</a> 
<a name="315" href="#315">315</a>    <em>/**<em>*</em></em>
<a name="316" href="#316">316</a> <em>    * Defines a search which defines only restrictions,</em>
<a name="317" href="#317">317</a> <em>    * defaults to AND restriction comparisons and returning all results</em>
<a name="318" href="#318">318</a> <em>    * @param restrictions define the limitations on the results of a search, </em>
<a name="319" href="#319">319</a> <em>    * e.g. propertyA > 100 or property B = 'jump'&lt;br/> </em>
<a name="320" href="#320">320</a> <em>    * You can add as many restrictions as you like and they will be applied in the array order</em>
<a name="321" href="#321">321</a> <em>    */</em>
<a name="322" href="#322">322</a>    <strong>public</strong> <a href="../../../../../org/sakaiproject/genericdao/api/search/Search.html">Search</a>(<a href="../../../../../org/sakaiproject/genericdao/api/search/Restriction.html">Restriction</a>[] restrictions) {
<a name="323" href="#323">323</a>       <strong>this</strong>.restrictions = restrictions;
<a name="324" href="#324">324</a>    }
<a name="325" href="#325">325</a> 
<a name="326" href="#326">326</a>    <em>/**<em>*</em></em>
<a name="327" href="#327">327</a> <em>    * Defines a search which defines only a single restriction and returns all items,</em>
<a name="328" href="#328">328</a> <em>    * defaults to AND restriction comparisons</em>
<a name="329" href="#329">329</a> <em>    * @param restriction define the limitations on the results of a search, </em>
<a name="330" href="#330">330</a> <em>    * e.g. propertyA > 100 or property B = 'jump'&lt;br/> </em>
<a name="331" href="#331">331</a> <em>    * You can add as many restrictions as you like and they will be applied in the array order</em>
<a name="332" href="#332">332</a> <em>    * @param order define the order of the returned results of a search (only one order)</em>
<a name="333" href="#333">333</a> <em>    */</em>
<a name="334" href="#334">334</a>    <strong>public</strong> <a href="../../../../../org/sakaiproject/genericdao/api/search/Search.html">Search</a>(<a href="../../../../../org/sakaiproject/genericdao/api/search/Restriction.html">Restriction</a> restriction, <a href="../../../../../org/sakaiproject/genericdao/api/search/Order.html">Order</a> order) {
<a name="335" href="#335">335</a>       <strong>this</strong>.restrictions = <strong>new</strong> <a href="../../../../../org/sakaiproject/genericdao/api/search/Restriction.html">Restriction</a>[] { restriction };
<a name="336" href="#336">336</a>       <strong>this</strong>.orders = <strong>new</strong> <a href="../../../../../org/sakaiproject/genericdao/api/search/Order.html">Order</a>[] { order };
<a name="337" href="#337">337</a>    }
<a name="338" href="#338">338</a> 
<a name="339" href="#339">339</a>    <em>/**<em>*</em></em>
<a name="340" href="#340">340</a> <em>    * Defines a search which defines restrictions and return ordering,</em>
<a name="341" href="#341">341</a> <em>    * defaults to AND restriction comparisons and returning all results</em>
<a name="342" href="#342">342</a> <em>    * @param restrictions define the limitations on the results of a search, </em>
<a name="343" href="#343">343</a> <em>    * e.g. propertyA > 100 or property B = 'jump'&lt;br/> </em>
<a name="344" href="#344">344</a> <em>    * You can add as many restrictions as you like and they will be applied in the array order</em>
<a name="345" href="#345">345</a> <em>    * @param order define the order of the returned results of a search (only one order)</em>
<a name="346" href="#346">346</a> <em>    */</em>
<a name="347" href="#347">347</a>    <strong>public</strong> <a href="../../../../../org/sakaiproject/genericdao/api/search/Search.html">Search</a>(<a href="../../../../../org/sakaiproject/genericdao/api/search/Restriction.html">Restriction</a>[] restrictions, <a href="../../../../../org/sakaiproject/genericdao/api/search/Order.html">Order</a> order) {
<a name="348" href="#348">348</a>       <strong>this</strong>.restrictions = restrictions;
<a name="349" href="#349">349</a>       <strong>this</strong>.orders = <strong>new</strong> <a href="../../../../../org/sakaiproject/genericdao/api/search/Order.html">Order</a>[] { order };
<a name="350" href="#350">350</a>    }
<a name="351" href="#351">351</a> 
<a name="352" href="#352">352</a>    <em>/**<em>*</em></em>
<a name="353" href="#353">353</a> <em>    * Defines a search which defines restrictions and return ordering,</em>
<a name="354" href="#354">354</a> <em>    * defaults to AND restriction comparisons and returning all results</em>
<a name="355" href="#355">355</a> <em>    * @param restrictions define the limitations on the results of a search, </em>
<a name="356" href="#356">356</a> <em>    * e.g. propertyA > 100 or property B = 'jump'&lt;br/> </em>
<a name="357" href="#357">357</a> <em>    * You can add as many restrictions as you like and they will be applied in the array order</em>
<a name="358" href="#358">358</a> <em>    * @param orders define the order of the returned results of a search, </em>
<a name="359" href="#359">359</a> <em>    * You can add as many orders as you like and they will be applied in the array order</em>
<a name="360" href="#360">360</a> <em>    */</em>
<a name="361" href="#361">361</a>    <strong>public</strong> <a href="../../../../../org/sakaiproject/genericdao/api/search/Search.html">Search</a>(<a href="../../../../../org/sakaiproject/genericdao/api/search/Restriction.html">Restriction</a>[] restrictions, <a href="../../../../../org/sakaiproject/genericdao/api/search/Order.html">Order</a>[] orders) {
<a name="362" href="#362">362</a>       <strong>this</strong>.restrictions = restrictions;
<a name="363" href="#363">363</a>       <strong>this</strong>.orders = orders;
<a name="364" href="#364">364</a>    }
<a name="365" href="#365">365</a> 
<a name="366" href="#366">366</a>    <em>/**<em>*</em></em>
<a name="367" href="#367">367</a> <em>    * Defines a search which defines only a single restriction and limits the returns,</em>
<a name="368" href="#368">368</a> <em>    * defaults to AND restriction comparisons</em>
<a name="369" href="#369">369</a> <em>    * @param restriction define the limitations on the results of a search, </em>
<a name="370" href="#370">370</a> <em>    * e.g. propertyA > 100 or property B = 'jump'&lt;br/> </em>
<a name="371" href="#371">371</a> <em>    * You can add as many restrictions as you like and they will be applied in the array order</em>
<a name="372" href="#372">372</a> <em>    * @param order define the order of the returned results of a search (only one order)</em>
<a name="373" href="#373">373</a> <em>    * @param start the index of the first persisted result object to be retrieved (numbered from 0)</em>
<a name="374" href="#374">374</a> <em>    * @param limit the maximum number of persisted result objects to retrieve (or &lt;=0 for no limit)</em>
<a name="375" href="#375">375</a> <em>    */</em>
<a name="376" href="#376">376</a>    <strong>public</strong> <a href="../../../../../org/sakaiproject/genericdao/api/search/Search.html">Search</a>(<a href="../../../../../org/sakaiproject/genericdao/api/search/Restriction.html">Restriction</a> restriction, <a href="../../../../../org/sakaiproject/genericdao/api/search/Order.html">Order</a> order, <strong>long</strong> start, <strong>long</strong> limit) {
<a name="377" href="#377">377</a>       <strong>this</strong>.restrictions = <strong>new</strong> <a href="../../../../../org/sakaiproject/genericdao/api/search/Restriction.html">Restriction</a>[] { restriction };
<a name="378" href="#378">378</a>       <strong>this</strong>.orders = <strong>new</strong> <a href="../../../../../org/sakaiproject/genericdao/api/search/Order.html">Order</a>[] { order };
<a name="379" href="#379">379</a>       <strong>this</strong>.start = start;
<a name="380" href="#380">380</a>       <strong>this</strong>.limit = limit;
<a name="381" href="#381">381</a>    }
<a name="382" href="#382">382</a> 
<a name="383" href="#383">383</a>    <em>/**<em>*</em></em>
<a name="384" href="#384">384</a> <em>    * Defines a search which defines restrictions and return ordering and limits the returns,</em>
<a name="385" href="#385">385</a> <em>    * defaults to AND restriction comparisons</em>
<a name="386" href="#386">386</a> <em>    * @param restrictions define the limitations on the results of a search, </em>
<a name="387" href="#387">387</a> <em>    * e.g. propertyA > 100 or property B = 'jump'&lt;br/> </em>
<a name="388" href="#388">388</a> <em>    * You can add as many restrictions as you like and they will be applied in the array order</em>
<a name="389" href="#389">389</a> <em>    * @param order define the order of the returned results of a search (only one order)</em>
<a name="390" href="#390">390</a> <em>    * @param start the index of the first persisted result object to be retrieved (numbered from 0)</em>
<a name="391" href="#391">391</a> <em>    * @param limit the maximum number of persisted result objects to retrieve (or &lt;=0 for no limit)</em>
<a name="392" href="#392">392</a> <em>    */</em>
<a name="393" href="#393">393</a>    <strong>public</strong> <a href="../../../../../org/sakaiproject/genericdao/api/search/Search.html">Search</a>(<a href="../../../../../org/sakaiproject/genericdao/api/search/Restriction.html">Restriction</a>[] restrictions, <a href="../../../../../org/sakaiproject/genericdao/api/search/Order.html">Order</a> order, <strong>long</strong> start, <strong>long</strong> limit) {
<a name="394" href="#394">394</a>       <strong>this</strong>.restrictions = restrictions;
<a name="395" href="#395">395</a>       <strong>this</strong>.orders = <strong>new</strong> <a href="../../../../../org/sakaiproject/genericdao/api/search/Order.html">Order</a>[] { order };
<a name="396" href="#396">396</a>       <strong>this</strong>.start = start;
<a name="397" href="#397">397</a>       <strong>this</strong>.limit = limit;
<a name="398" href="#398">398</a>    }
<a name="399" href="#399">399</a> 
<a name="400" href="#400">400</a>    <em>/**<em>*</em></em>
<a name="401" href="#401">401</a> <em>    * Defines a search which defines restrictions and return ordering and limits the returns,</em>
<a name="402" href="#402">402</a> <em>    * defaults to AND restriction comparisons</em>
<a name="403" href="#403">403</a> <em>    * @param restrictions define the limitations on the results of a search, </em>
<a name="404" href="#404">404</a> <em>    * e.g. propertyA > 100 or property B = 'jump'&lt;br/> </em>
<a name="405" href="#405">405</a> <em>    * You can add as many restrictions as you like and they will be applied in the array order</em>
<a name="406" href="#406">406</a> <em>    * @param orders define the order of the returned results of a search, </em>
<a name="407" href="#407">407</a> <em>    * You can add as many orders as you like and they will be applied in the array order</em>
<a name="408" href="#408">408</a> <em>    * @param start the index of the first persisted result object to be retrieved (numbered from 0)</em>
<a name="409" href="#409">409</a> <em>    * @param limit the maximum number of persisted result objects to retrieve (or &lt;=0 for no limit)</em>
<a name="410" href="#410">410</a> <em>    */</em>
<a name="411" href="#411">411</a>    <strong>public</strong> <a href="../../../../../org/sakaiproject/genericdao/api/search/Search.html">Search</a>(<a href="../../../../../org/sakaiproject/genericdao/api/search/Restriction.html">Restriction</a>[] restrictions, <a href="../../../../../org/sakaiproject/genericdao/api/search/Order.html">Order</a>[] orders, <strong>long</strong> start, <strong>long</strong> limit) {
<a name="412" href="#412">412</a>       <strong>this</strong>.restrictions = restrictions;
<a name="413" href="#413">413</a>       <strong>this</strong>.orders = orders;
<a name="414" href="#414">414</a>       <strong>this</strong>.start = start;
<a name="415" href="#415">415</a>       <strong>this</strong>.limit = limit;
<a name="416" href="#416">416</a>    }
<a name="417" href="#417">417</a> 
<a name="418" href="#418">418</a>    <em>/**<em>*</em></em>
<a name="419" href="#419">419</a> <em>    * Defines a search which defines restrictions and return ordering and limits the returns,</em>
<a name="420" href="#420">420</a> <em>    * also specifies the types of restriction comparisons (AND or OR)</em>
<a name="421" href="#421">421</a> <em>    * @param restrictions define the limitations on the results of a search, </em>
<a name="422" href="#422">422</a> <em>    * e.g. propertyA > 100 or property B = 'jump'&lt;br/> </em>
<a name="423" href="#423">423</a> <em>    * You can add as many restrictions as you like and they will be applied in the array order</em>
<a name="424" href="#424">424</a> <em>    * @param order define the order of the returned results of a search (only one order)</em>
<a name="425" href="#425">425</a> <em>    * @param start the index of the first persisted result object to be retrieved (numbered from 0)</em>
<a name="426" href="#426">426</a> <em>    * @param limit the maximum number of persisted result objects to retrieve (or &lt;=0 for no limit)</em>
<a name="427" href="#427">427</a> <em>    * @param conjunction if true then all restrictions are run using AND, </em>
<a name="428" href="#428">428</a> <em>    * if false then all restrictions are run using OR</em>
<a name="429" href="#429">429</a> <em>    */</em>
<a name="430" href="#430">430</a>    <strong>public</strong> <a href="../../../../../org/sakaiproject/genericdao/api/search/Search.html">Search</a>(<a href="../../../../../org/sakaiproject/genericdao/api/search/Restriction.html">Restriction</a>[] restrictions, <a href="../../../../../org/sakaiproject/genericdao/api/search/Order.html">Order</a> order, <strong>long</strong> start, <strong>long</strong> limit, <strong>boolean</strong> conjunction) {
<a name="431" href="#431">431</a>       <strong>this</strong>.restrictions = restrictions;
<a name="432" href="#432">432</a>       <strong>this</strong>.orders = <strong>new</strong> <a href="../../../../../org/sakaiproject/genericdao/api/search/Order.html">Order</a>[] { order };
<a name="433" href="#433">433</a>       <strong>this</strong>.start = start;
<a name="434" href="#434">434</a>       <strong>this</strong>.limit = limit;
<a name="435" href="#435">435</a>       <strong>this</strong>.conjunction = conjunction;
<a name="436" href="#436">436</a>    }
<a name="437" href="#437">437</a> 
<a name="438" href="#438">438</a>    <em>/**<em>*</em></em>
<a name="439" href="#439">439</a> <em>    * Defines a search which defines restrictions and return ordering and limits the returns,</em>
<a name="440" href="#440">440</a> <em>    * also specifies the types of restriction comparisons (AND or OR)</em>
<a name="441" href="#441">441</a> <em>    * @param restrictions define the limitations on the results of a search, </em>
<a name="442" href="#442">442</a> <em>    * e.g. propertyA > 100 or property B = 'jump'&lt;br/> </em>
<a name="443" href="#443">443</a> <em>    * You can add as many restrictions as you like and they will be applied in the array order</em>
<a name="444" href="#444">444</a> <em>    * @param orders define the order of the returned results of a search, </em>
<a name="445" href="#445">445</a> <em>    * You can add as many orders as you like and they will be applied in the array order</em>
<a name="446" href="#446">446</a> <em>    * @param start the index of the first persisted result object to be retrieved (numbered from 0)</em>
<a name="447" href="#447">447</a> <em>    * @param limit the maximum number of persisted result objects to retrieve (or &lt;=0 for no limit)</em>
<a name="448" href="#448">448</a> <em>    * @param conjunction if true then all restrictions are run using AND, </em>
<a name="449" href="#449">449</a> <em>    * if false then all restrictions are run using OR</em>
<a name="450" href="#450">450</a> <em>    */</em>
<a name="451" href="#451">451</a>    <strong>public</strong> <a href="../../../../../org/sakaiproject/genericdao/api/search/Search.html">Search</a>(<a href="../../../../../org/sakaiproject/genericdao/api/search/Restriction.html">Restriction</a>[] restrictions, <a href="../../../../../org/sakaiproject/genericdao/api/search/Order.html">Order</a>[] orders, <strong>long</strong> start, <strong>long</strong> limit, <strong>boolean</strong> conjunction) {
<a name="452" href="#452">452</a>       <strong>this</strong>.restrictions = restrictions;
<a name="453" href="#453">453</a>       <strong>this</strong>.orders = orders;
<a name="454" href="#454">454</a>       <strong>this</strong>.start = start;
<a name="455" href="#455">455</a>       <strong>this</strong>.limit = limit;
<a name="456" href="#456">456</a>       <strong>this</strong>.conjunction = conjunction;
<a name="457" href="#457">457</a>    }
<a name="458" href="#458">458</a> 
<a name="459" href="#459">459</a>    <em class="comment">// HELPER methods</em>
<a name="460" href="#460">460</a> 
<a name="461" href="#461">461</a>    <em>/**<em>*</em></em>
<a name="462" href="#462">462</a> <em>    * @param restriction add this restriction to the search filter,</em>
<a name="463" href="#463">463</a> <em>    * will replace an existing restriction for a similar property</em>
<a name="464" href="#464">464</a> <em>    */</em>
<a name="465" href="#465">465</a>    <strong>public</strong> <strong>void</strong> addRestriction(<a href="../../../../../org/sakaiproject/genericdao/api/search/Restriction.html">Restriction</a> restriction) {
<a name="466" href="#466">466</a>       <strong>if</strong> (restrictions != <strong>null</strong>) {
<a name="467" href="#467">467</a>          <strong>int</strong> location = contains(restrictions, restriction);
<a name="468" href="#468">468</a>          <strong>if</strong> (location >= 0 
<a name="469" href="#469">469</a>                &amp;&amp; location &lt; restrictions.length) {
<a name="470" href="#470">470</a>             restrictions[location] = restriction;
<a name="471" href="#471">471</a>          } <strong>else</strong> {
<a name="472" href="#472">472</a>             restrictions = appendArray(restrictions, restriction);
<a name="473" href="#473">473</a>          }
<a name="474" href="#474">474</a>       } <strong>else</strong> {
<a name="475" href="#475">475</a>          restrictions = <strong>new</strong> <a href="../../../../../org/sakaiproject/genericdao/api/search/Restriction.html">Restriction</a>[] {restriction};
<a name="476" href="#476">476</a>       }
<a name="477" href="#477">477</a>    }
<a name="478" href="#478">478</a> 
<a name="479" href="#479">479</a>    <em>/**<em>*</em></em>
<a name="480" href="#480">480</a> <em>    * @param order add this order to the search filter,</em>
<a name="481" href="#481">481</a> <em>    * will replace an existing order for a similar property</em>
<a name="482" href="#482">482</a> <em>    */</em>
<a name="483" href="#483">483</a>    <strong>public</strong> <strong>void</strong> addOrder(<a href="../../../../../org/sakaiproject/genericdao/api/search/Order.html">Order</a> order) {
<a name="484" href="#484">484</a>       <strong>if</strong> (orders != <strong>null</strong>) {
<a name="485" href="#485">485</a>          <strong>int</strong> location = contains(orders, order);
<a name="486" href="#486">486</a>          <strong>if</strong> (location >= 0 
<a name="487" href="#487">487</a>                &amp;&amp; location &lt; orders.length) {
<a name="488" href="#488">488</a>             orders[location] = order;
<a name="489" href="#489">489</a>          } <strong>else</strong> {
<a name="490" href="#490">490</a>             orders = appendArray(orders, order);
<a name="491" href="#491">491</a>          }
<a name="492" href="#492">492</a>       } <strong>else</strong> {
<a name="493" href="#493">493</a>          orders = <strong>new</strong> <a href="../../../../../org/sakaiproject/genericdao/api/search/Order.html">Order</a>[] {order};
<a name="494" href="#494">494</a>       }
<a name="495" href="#495">495</a>    }
<a name="496" href="#496">496</a> 
<a name="497" href="#497">497</a>    <em>/**<em>*</em></em>
<a name="498" href="#498">498</a> <em>    * Convenient method to find restrictions by their property,</em>
<a name="499" href="#499">499</a> <em>    * if there happens to be more than one restriction with a property then</em>
<a name="500" href="#500">500</a> <em>    * only the first one will be returned (since that is an invalid state)</em>
<a name="501" href="#501">501</a> <em>    * </em>
<a name="502" href="#502">502</a> <em>    * @param property the property to match</em>
<a name="503" href="#503">503</a> <em>    * @return the Restriction with this property or null if none found</em>
<a name="504" href="#504">504</a> <em>    */</em>
<a name="505" href="#505">505</a>    <strong>public</strong> <a href="../../../../../org/sakaiproject/genericdao/api/search/Restriction.html">Restriction</a> getRestrictionByProperty(String property) {
<a name="506" href="#506">506</a>       <a href="../../../../../org/sakaiproject/genericdao/api/search/Restriction.html">Restriction</a> r = <strong>null</strong>;
<a name="507" href="#507">507</a>       <strong>if</strong> (restrictions != <strong>null</strong> &amp;&amp; property != <strong>null</strong>) {
<a name="508" href="#508">508</a>          <strong>for</strong> (<strong>int</strong> i = 0; i &lt; restrictions.length; i++) {
<a name="509" href="#509">509</a>             <strong>if</strong> (property.equals(restrictions[i].property)) {
<a name="510" href="#510">510</a>                r = restrictions[i];
<a name="511" href="#511">511</a>                <strong>break</strong>;
<a name="512" href="#512">512</a>             }
<a name="513" href="#513">513</a>          }         
<a name="514" href="#514">514</a>       }
<a name="515" href="#515">515</a>       <strong>return</strong> r;
<a name="516" href="#516">516</a>    }
<a name="517" href="#517">517</a> 
<a name="518" href="#518">518</a>    <em>/**<em>*</em></em>
<a name="519" href="#519">519</a> <em>    * @return a list of all the properties on all restrictions in this search filter object</em>
<a name="520" href="#520">520</a> <em>    */</em>
<a name="521" href="#521">521</a>    <strong>public</strong> List&lt;String> getRestrictionsProperties() {
<a name="522" href="#522">522</a>       List&lt;String> l = <strong>new</strong> ArrayList&lt;String>();
<a name="523" href="#523">523</a>       <strong>if</strong> (restrictions != <strong>null</strong>) {
<a name="524" href="#524">524</a>          <strong>for</strong> (<strong>int</strong> i = 0; i &lt; restrictions.length; i++) {
<a name="525" href="#525">525</a>             l.add(restrictions[i].property);
<a name="526" href="#526">526</a>          }         
<a name="527" href="#527">527</a>       }      
<a name="528" href="#528">528</a>       <strong>return</strong> l;
<a name="529" href="#529">529</a>    }
<a name="530" href="#530">530</a> 
<a name="531" href="#531">531</a>    <em>/**<em>*</em></em>
<a name="532" href="#532">532</a> <em>    * Finds if there are any search restrictions with one of the given properties, </em>
<a name="533" href="#533">533</a> <em>    * if so it returns the first of the found restriction,</em>
<a name="534" href="#534">534</a> <em>    * otherwise returns null</em>
<a name="535" href="#535">535</a> <em>    * </em>
<a name="536" href="#536">536</a> <em>    * @param properties an array of the properties (e.g. 'name','age') to find a value for</em>
<a name="537" href="#537">537</a> <em>    * @return the value OR null if none found</em>
<a name="538" href="#538">538</a> <em>    */</em>
<a name="539" href="#539">539</a>    <strong>public</strong> <a href="../../../../../org/sakaiproject/genericdao/api/search/Restriction.html">Restriction</a> getRestrictionByProperties(String[] properties) {
<a name="540" href="#540">540</a>        <a href="../../../../../org/sakaiproject/genericdao/api/search/Restriction.html">Restriction</a> togo = <strong>null</strong>;
<a name="541" href="#541">541</a>        <strong>for</strong> (<strong>int</strong> i = 0; i &lt; properties.length; i++) {
<a name="542" href="#542">542</a>            String property = properties[i];
<a name="543" href="#543">543</a>            <a href="../../../../../org/sakaiproject/genericdao/api/search/Restriction.html">Restriction</a> r = <strong>this</strong>.getRestrictionByProperty(property);
<a name="544" href="#544">544</a>            <strong>if</strong> (r != <strong>null</strong>) {
<a name="545" href="#545">545</a>                togo = r;
<a name="546" href="#546">546</a>                <strong>break</strong>;
<a name="547" href="#547">547</a>            }
<a name="548" href="#548">548</a>        }
<a name="549" href="#549">549</a>        <strong>return</strong> togo;
<a name="550" href="#550">550</a>    }
<a name="551" href="#551">551</a> 
<a name="552" href="#552">552</a>    <em>/**<em>*</em></em>
<a name="553" href="#553">553</a> <em>    * Finds if there are any search restrictions with one of the given properties, </em>
<a name="554" href="#554">554</a> <em>    * if so it returns the first non-null value in the found restrictions,</em>
<a name="555" href="#555">555</a> <em>    * otherwise returns null</em>
<a name="556" href="#556">556</a> <em>    *</em>
<a name="557" href="#557">557</a> <em>    * @param properties an array of the properties (e.g. 'name','age') to find a value for</em>
<a name="558" href="#558">558</a> <em>    * @return the value OR null if none found</em>
<a name="559" href="#559">559</a> <em>    */</em>
<a name="560" href="#560">560</a>    <strong>public</strong> Object getRestrictionValueByProperties(String[] properties) {
<a name="561" href="#561">561</a>        Object value = <strong>null</strong>;
<a name="562" href="#562">562</a>        <strong>for</strong> (<strong>int</strong> i = 0; i &lt; properties.length; i++) {
<a name="563" href="#563">563</a>            String property = properties[i];
<a name="564" href="#564">564</a>            <a href="../../../../../org/sakaiproject/genericdao/api/search/Restriction.html">Restriction</a> r = <strong>this</strong>.getRestrictionByProperty(property);
<a name="565" href="#565">565</a>            <strong>if</strong> (r != <strong>null</strong>) {
<a name="566" href="#566">566</a>                <strong>if</strong> (r.getValue() != <strong>null</strong>) {
<a name="567" href="#567">567</a>                    value = r.getValue();
<a name="568" href="#568">568</a>                    <strong>break</strong>;
<a name="569" href="#569">569</a>                }
<a name="570" href="#570">570</a>            }
<a name="571" href="#571">571</a>        }
<a name="572" href="#572">572</a>        <strong>return</strong> value;
<a name="573" href="#573">573</a>    }
<a name="574" href="#574">574</a> 
<a name="575" href="#575">575</a>    <em>/**<em>*</em></em>
<a name="576" href="#576">576</a> <em>    * @return true if this search has no defined restrictions and no orders</em>
<a name="577" href="#577">577</a> <em>    * (i.e. this is a default search so return everything in default order),</em>
<a name="578" href="#578">578</a> <em>    * false if there are any defined restrictions or orders</em>
<a name="579" href="#579">579</a> <em>    */</em>
<a name="580" href="#580">580</a>    <strong>public</strong> <strong>boolean</strong> isEmpty() {
<a name="581" href="#581">581</a>       <strong>boolean</strong> empty = false;
<a name="582" href="#582">582</a>       <strong>if</strong> ((restrictions == <strong>null</strong> || restrictions.length == 0) 
<a name="583" href="#583">583</a>             &amp;&amp; (orders == <strong>null</strong> || orders.length == 0) 
<a name="584" href="#584">584</a>             &amp;&amp; queryString == <strong>null</strong>) {
<a name="585" href="#585">585</a>          empty = <strong>true</strong>;
<a name="586" href="#586">586</a>       }
<a name="587" href="#587">587</a>       <strong>return</strong> empty;
<a name="588" href="#588">588</a>    }
<a name="589" href="#589">589</a> 
<a name="590" href="#590">590</a>    <em>/**<em>*</em></em>
<a name="591" href="#591">591</a> <em>    * Resets the search object to empty state</em>
<a name="592" href="#592">592</a> <em>    */</em>
<a name="593" href="#593">593</a>    <strong>public</strong> <strong>void</strong> reset() {
<a name="594" href="#594">594</a>       restrictions = <strong>new</strong> <a href="../../../../../org/sakaiproject/genericdao/api/search/Restriction.html">Restriction</a>[] {};
<a name="595" href="#595">595</a>       orders = <strong>new</strong> <a href="../../../../../org/sakaiproject/genericdao/api/search/Order.html">Order</a>[] {};
<a name="596" href="#596">596</a>       conjunction = false;
<a name="597" href="#597">597</a>       queryString = <strong>null</strong>;
<a name="598" href="#598">598</a>       start = 0;
<a name="599" href="#599">599</a>       limit = 0;
<a name="600" href="#600">600</a>    }
<a name="601" href="#601">601</a> 
<a name="602" href="#602">602</a>    <em>/**<em>*</em></em>
<a name="603" href="#603">603</a> <em>    * Checks to see if an array contains a value,</em>
<a name="604" href="#604">604</a> <em>    * will return the position of the value or -1 if not found</em>
<a name="605" href="#605">605</a> <em>    * </em>
<a name="606" href="#606">606</a> <em>    * @param &lt;T></em>
<a name="607" href="#607">607</a> <em>    * @param array any array of objects</em>
<a name="608" href="#608">608</a> <em>    * @param value the value to check for</em>
<a name="609" href="#609">609</a> <em>    * @return array position if found, -1 if not found</em>
<a name="610" href="#610">610</a> <em>    */</em>
<a name="611" href="#611">611</a>    <strong>public</strong> <strong>static</strong> &lt;T> <strong>int</strong> contains(T[] array, T value) {
<a name="612" href="#612">612</a>       <strong>int</strong> position = -1;
<a name="613" href="#613">613</a>       <strong>if</strong> (value != <strong>null</strong>) {
<a name="614" href="#614">614</a>          <strong>for</strong> (<strong>int</strong> i = 0; i &lt; array.length; i++) {
<a name="615" href="#615">615</a>             <strong>if</strong> (value.equals(array[i])) {
<a name="616" href="#616">616</a>                position = i;
<a name="617" href="#617">617</a>                <strong>break</strong>;
<a name="618" href="#618">618</a>             }
<a name="619" href="#619">619</a>          }
<a name="620" href="#620">620</a>       }
<a name="621" href="#621">621</a>       <strong>return</strong> position;
<a name="622" href="#622">622</a>    }
<a name="623" href="#623">623</a> 
<a name="624" href="#624">624</a>    <em>/**<em>*</em></em>
<a name="625" href="#625">625</a> <em>    * Append an item to the end of an array and return the new array</em>
<a name="626" href="#626">626</a> <em>    * </em>
<a name="627" href="#627">627</a> <em>    * @param array an array of items</em>
<a name="628" href="#628">628</a> <em>    * @param value the item to append to the end of the new array</em>
<a name="629" href="#629">629</a> <em>    * @return a new array with value in the last spot</em>
<a name="630" href="#630">630</a> <em>    */</em>
<a name="631" href="#631">631</a>    @SuppressWarnings(<span class="string">"unchecked"</span>)
<a name="632" href="#632">632</a>    <strong>public</strong> <strong>static</strong> &lt;T> T[] appendArray(T[] array, T value) {
<a name="633" href="#633">633</a>       Class&lt;?> type = array.getClass().getComponentType();
<a name="634" href="#634">634</a>       T[] newArray = (T[]) Array.newInstance(type, array.length + 1);
<a name="635" href="#635">635</a>       System.arraycopy( array, 0, newArray, 0, array.length );
<a name="636" href="#636">636</a>       newArray[newArray.length-1] = value;
<a name="637" href="#637">637</a>       <strong>return</strong> newArray;
<a name="638" href="#638">638</a>    }
<a name="639" href="#639">639</a> 
<a name="640" href="#640">640</a>    <em>/**<em>*</em></em>
<a name="641" href="#641">641</a> <em>    * Utility method to convert an array to a string</em>
<a name="642" href="#642">642</a> <em>    * @param array any array</em>
<a name="643" href="#643">643</a> <em>    * @return a string version of the array</em>
<a name="644" href="#644">644</a> <em>    */</em>
<a name="645" href="#645">645</a>    <strong>public</strong> <strong>static</strong> String arrayToString(Object[] array) {
<a name="646" href="#646">646</a>       StringBuilder result = <strong>new</strong> StringBuilder();
<a name="647" href="#647">647</a>       <strong>if</strong> (array != <strong>null</strong> &amp;&amp; array.length > 0) {
<a name="648" href="#648">648</a>          <strong>for</strong> (<strong>int</strong> i = 0; i &lt; array.length; i++) {
<a name="649" href="#649">649</a>             <strong>if</strong> (i > 0) {
<a name="650" href="#650">650</a>                result.append(<span class="string">","</span>);
<a name="651" href="#651">651</a>             }
<a name="652" href="#652">652</a>             <strong>if</strong> (array[i] != <strong>null</strong>) {
<a name="653" href="#653">653</a>                result.append(array[i].toString());
<a name="654" href="#654">654</a>             }
<a name="655" href="#655">655</a>          }
<a name="656" href="#656">656</a>       }
<a name="657" href="#657">657</a>       <strong>return</strong> result.toString();
<a name="658" href="#658">658</a>    }
<a name="659" href="#659">659</a> 
<a name="660" href="#660">660</a>    @Override
<a name="661" href="#661">661</a>    <strong>protected</strong> Object clone() throws CloneNotSupportedException {
<a name="662" href="#662">662</a>       <strong>return</strong> copy(<strong>this</strong>, <strong>null</strong>);
<a name="663" href="#663">663</a>    }
<a name="664" href="#664">664</a> 
<a name="665" href="#665">665</a>    <em>/**<em>*</em></em>
<a name="666" href="#666">666</a> <em>    * Make a copy of a search object</em>
<a name="667" href="#667">667</a> <em>    * @param original the search object to copy</em>
<a name="668" href="#668">668</a> <em>    * @param copy the search object make equivalent to the original,</em>
<a name="669" href="#669">669</a> <em>    * can be null to generate a new one</em>
<a name="670" href="#670">670</a> <em>    * @return the copy of the original</em>
<a name="671" href="#671">671</a> <em>    */</em>
<a name="672" href="#672">672</a>    <strong>public</strong> <strong>static</strong> <a href="../../../../../org/sakaiproject/genericdao/api/search/Search.html">Search</a> copy(<a href="../../../../../org/sakaiproject/genericdao/api/search/Search.html">Search</a> original, <a href="../../../../../org/sakaiproject/genericdao/api/search/Search.html">Search</a> copy) {
<a name="673" href="#673">673</a>       <strong>if</strong> (copy == <strong>null</strong>) {
<a name="674" href="#674">674</a>          copy = <strong>new</strong> <a href="../../../../../org/sakaiproject/genericdao/api/search/Search.html">Search</a>();
<a name="675" href="#675">675</a>       }
<a name="676" href="#676">676</a>       copy.setStart(original.getStart());
<a name="677" href="#677">677</a>       copy.setLimit(original.getLimit());
<a name="678" href="#678">678</a>       copy.setConjunction(original.isConjunction());
<a name="679" href="#679">679</a>       copy.setQueryString(original.getQueryString());
<a name="680" href="#680">680</a>       <em class="comment">// TODO probably need to copy the arrays here</em>
<a name="681" href="#681">681</a>       copy.setRestrictions(original.getRestrictions());
<a name="682" href="#682">682</a>       copy.setOrders(original.getOrders());
<a name="683" href="#683">683</a>       <strong>return</strong> copy;
<a name="684" href="#684">684</a>    }
<a name="685" href="#685">685</a> 
<a name="686" href="#686">686</a>    @Override
<a name="687" href="#687">687</a>    <strong>public</strong> <strong>boolean</strong> equals(Object obj) {
<a name="688" href="#688">688</a>       <strong>if</strong> (<strong>null</strong> == obj)
<a name="689" href="#689">689</a>          <strong>return</strong> false;
<a name="690" href="#690">690</a>       <strong>if</strong> (!(obj instanceof Search))
<a name="691" href="#691">691</a>          <strong>return</strong> false;
<a name="692" href="#692">692</a>       <strong>else</strong> {
<a name="693" href="#693">693</a>          <a href="../../../../../org/sakaiproject/genericdao/api/search/Search.html">Search</a> castObj = (Search) obj;
<a name="694" href="#694">694</a>          <strong>boolean</strong> eq = <strong>this</strong>.start == castObj.start
<a name="695" href="#695">695</a>                &amp;&amp; <strong>this</strong>.limit == castObj.limit
<a name="696" href="#696">696</a>                &amp;&amp; <strong>this</strong>.conjunction == castObj.conjunction
<a name="697" href="#697">697</a>                &amp;&amp; (<strong>this</strong>.queryString == <strong>null</strong> ? castObj.queryString == <strong>null</strong> : <strong>this</strong>.queryString.equals(castObj.queryString))
<a name="698" href="#698">698</a>                &amp;&amp; Arrays.deepEquals(<strong>this</strong>.restrictions, castObj.restrictions)
<a name="699" href="#699">699</a>                &amp;&amp; Arrays.deepEquals(<strong>this</strong>.orders, castObj.orders);
<a name="700" href="#700">700</a>          <strong>return</strong> eq;
<a name="701" href="#701">701</a>       }
<a name="702" href="#702">702</a>    }
<a name="703" href="#703">703</a> 
<a name="704" href="#704">704</a>    @Override
<a name="705" href="#705">705</a>    <strong>public</strong> <strong>int</strong> hashCode() {
<a name="706" href="#706">706</a>       <strong>if</strong> (<strong>this</strong>.isEmpty())
<a name="707" href="#707">707</a>          <strong>return</strong> <strong>super</strong>.hashCode();
<a name="708" href="#708">708</a>       String hashStr = <strong>this</strong>.getClass().getName() + <span class="string">":"</span> + <strong>this</strong>.start + <span class="string">":"</span> + <strong>this</strong>.limit + <span class="string">":"</span> + <strong>this</strong>.conjunction + <span class="string">":"</span>
<a name="709" href="#709">709</a>          + <strong>this</strong>.queryString + <span class="string">":"</span> + arrayToString(restrictions) + <span class="string">":"</span> + arrayToString(orders);
<a name="710" href="#710">710</a>       <strong>return</strong> hashStr.hashCode();
<a name="711" href="#711">711</a>    }
<a name="712" href="#712">712</a> 
<a name="713" href="#713">713</a>    @Override
<a name="714" href="#714">714</a>    <strong>public</strong> String toString() {
<a name="715" href="#715">715</a>       <strong>return</strong> <span class="string">"search::start:"</span> + start + <span class="string">",limit:"</span> + limit + <span class="string">",conj:"</span> + conjunction + <span class="string">",query:"</span> + queryString 
<a name="716" href="#716">716</a>          + <span class="string">",restricts:"</span> + arrayToString(restrictions) + <span class="string">",orders:"</span> + arrayToString(orders);
<a name="717" href="#717">717</a>    }
<a name="718" href="#718">718</a> 
<a name="719" href="#719">719</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

